Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Improve JPQL style for programming repositories #7975

Merged
merged 10 commits into from
Feb 13, 2024

Conversation

julian-christl
Copy link
Member

@julian-christl julian-christl commented Jan 29, 2024

Checklist

General

Server

Motivation and Context

I just fixed the style in one repository so I decided to go through some more repos to make the codebase more consistent and clean.

Description

I enforced capitalisation (SELECT instead of select), simple variable declaration (:var instead of :#{#var}, explicit enum values, consistent newlines and indentations

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Test Coverage

No functional changes.

Summary by CodeRabbit

  • Refactor
    • Enhanced readability and maintainability of JPQL queries across various repositories by simplifying conditions, using explicit joins, and ensuring proper use of enum references.
    • Improved query performance potential through more efficient query structures and removal of unnecessary expressions.
  • Bug Fixes
    • Fixed query parameter references to ensure correct execution of database operations.
  • Style
    • Adjusted query formatting for better readability without altering the logic.

Copy link

coderabbitai bot commented Jan 29, 2024

Warning

Rate Limit Exceeded

@Strohgelaender has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 26 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between d6b88af and 611e77d.

Walkthrough

The recent updates across various repository files in the Artemis project focus on enhancing query readability, performance, and maintainability. Changes include the normalization of JPQL query syntax, such as using the MAX function correctly, replacing string literals with fully qualified enum references, simplifying SQL queries, and removing unnecessary SpEL expressions. These modifications aim to make the codebase more efficient and easier to understand, potentially leading to improved execution times and easier future modifications.

Changes

File(s) Change Summary
.../BuildJobRepository.java Updated JPQL query syntax for buildStartDate and parameter references in the WHERE clause.
.../BuildLogStatisticsEntryRepository.java Refactored query structure for better readability and performance.
.../ProgrammingExerciseRepository.java, .../StaticCodeAnalysisCategoryRepository.java Reformatted queries for improved readability.
.../ProgrammingExerciseStudentParticipationRepository.java, .../ProgrammingExerciseStudentParticipationTestRepository.java Simplified SQL queries, removed unnecessary SpEL expressions, and adjusted comparison operators.
.../ProgrammingExerciseTestCaseRepository.java, .../ProgrammingSubmissionRepository.java Modified JPQL queries to use explicit join syntax and fully qualified enum names.
.../SolutionProgrammingExerciseParticipationRepository.java, .../TemplateProgrammingExerciseParticipationRepository.java Replaced @EntityGraph and @Query annotations with direct JPQL queries using explicit JOIN FETCH clauses.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) labels Jan 29, 2024
@julian-christl julian-christl marked this pull request as draft January 30, 2024 16:09
@julian-christl julian-christl marked this pull request as ready for review January 30, 2024 18:02
@julian-christl julian-christl requested a review from a team January 31, 2024 21:50
Strohgelaender
Strohgelaender previously approved these changes Feb 4, 2024
Strohgelaender
Strohgelaender previously approved these changes Feb 5, 2024
@MaximilianAnzinger MaximilianAnzinger added the maintainer-approved The feature maintainer has approved the PR label Feb 13, 2024
@bassner bassner added this to the 6.8.1 milestone Feb 13, 2024
@bassner bassner merged commit 968270e into develop Feb 13, 2024
35 of 39 checks passed
@bassner bassner deleted the chore/sql-style/programming branch February 13, 2024 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore code quality maintainer-approved The feature maintainer has approved the PR ready for review server Pull requests that update Java code. (Added Automatically!) tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants